<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Xmla.Dataset</title>
    <link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.1&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
    <link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
    <script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.5.1&#x2F;build&#x2F;yui&#x2F;yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><img src="..&#x2F;assets/css/logo.png" title=""></h1>
            
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: </em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
            <li><a href="#api-modules">Modules</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="..&#x2F;classes/Xmla.html">Xmla</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.html">Xmla.Dataset</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.Axis.html">Xmla.Dataset.Axis</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.Cellset.html">Xmla.Dataset.Cellset</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Exception.html">Xmla.Exception</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Rowset.html">Xmla.Rowset</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="..&#x2F;modules/xmla.html">xmla</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked>
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>


            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1>Xmla.Dataset Class</h1>
<div class="box meta">
    

    

    
        <div class="foundat">
            Defined in: <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5474"><code>src&#x2F;Xmla.js:5474</code></a>
        </div>
    

    
        
            Module: <a href="../modules/xmla.html">xmla</a>
        
    

    
</div>



<div class="box intro">
    <p>
This class implements an XML/A multidimensional Dataset object.
</p>

<p>
You do not need to instantiate objects of this class yourself.
Rather, the <code><a href="Xmla.html#class_Xmla">Xmla</a></code> class will instantiate this class
to convey the result of the <code>executeMultiDimensional</code> method
(see <code><a href="Xmla.html#method_executeMultiDimensional">executeMultiDimensional()</a></code>),
and possibly the <code>execute</code> method.
(Note that the <code><a name="Xmla.html#method_execute">execute()</code> instantiates either the
<code><a href="Xmla.html#class_Xmla.Rowset">Xmla.Rowset</a></code> or the <code><a href="Xmla.html#class_Xmla.Rowset">Xmla.Dataset</a></code> class
depending on the value of the <code>Format</code> property in the options passed to the <code><a href="Xmla.html#method_execute">execute()</a></code> method.)
</p>

<p>
An instance of the <code>Xmla.Dataset</code> class may be returned immediately as return value from these methods when doing a synchronous request.
In addition, the <code>Xmla.Dataset</code> object is available in the eventdata passed to any registered listeners
(see <code><a href="Xmla.html#method_addListener">addListener()</a></code>).
</p>
</div>


    <div class="constructor">
        <h2>Constructor</h2>
        <div id="method_Xmla.Dataset" class="method item">
    <h3 class="name"><code>Xmla.Dataset</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>doc</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5474"><code>src&#x2F;Xmla.js:5474</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">doc</code>
                        <span class="type">DOMDocument</span>
                    

                    

                    <div class="param-description">
                        <p>The responseXML result returned by server in response to a <code>Execute</code> request.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

    </div>


<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

        
            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
        
        
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
        
        
        
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

            
                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                        
                            <li class="index-item method">
                                <a href="#method_axisCount">axisCount</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_cellOrdinalForTupleIndexes">cellOrdinalForTupleIndexes</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_close">close</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_fetchAsObject">fetchAsObject</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getAxis">getAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getCellset">getCellset</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getChapterAxis">getChapterAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getColumnAxis">getColumnAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getPageAxis">getPageAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getRowAxis">getRowAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getSectionAxis">getSectionAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getSlicerAxis">getSlicerAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasAxis">hasAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasChapterAxis">hasChapterAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasColumnAxis">hasColumnAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasPageAxis">hasPageAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasRowAxis">hasRowAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasSectionAxis">hasSectionAxis</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasSlicerAxis">hasSlicerAxis</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            
                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties">
                        
                            <li class="index-item property">
                                <a href="#property_AXIS_CHAPTERS">AXIS_CHAPTERS</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_AXIS_COLUMNS">AXIS_COLUMNS</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_AXIS_PAGES">AXIS_PAGES</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_AXIS_ROWS">AXIS_ROWS</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_AXIS_SECTIONS">AXIS_SECTIONS</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_AXIS_SLICER">AXIS_SLICER</a>

                                
                                    <span class="flag static">static</span>
                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            

            
        </div>

        
            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

                
                    <div id="method_axisCount" class="method item">
    <h3 class="name"><code>axisCount</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5637"><code>src&#x2F;Xmla.js:5637</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the number of proper axes in this Dataset. This is the number of axes that appears in the <code>SELECT</code> list, and excludes the slicer axis.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_cellOrdinalForTupleIndexes" class="method item">
    <h3 class="name"><code>cellOrdinalForTupleIndexes</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>A</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5796"><code>src&#x2F;Xmla.js:5796</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Calculate the cellset ordinal for the argument tuple indexes.</p>

<p>This method accepts a variable number of tuple indexes. One integer argument must be passed for each proper axis (excluding the slicer axis).
Each integer arguments represent the index of a tuple on the respective axis.</p>

<p>The arguments must be specified by descending axis order. So if the data set has two axes (a row and a column axis),
this method expects the tuple index of a tuple on the row axis first, and after that, the tuple index on the column axis.</p>

<p>The method returns an integer that represents the ordinal of the cell identified by the tuples specified by the tuple index arguments.
One could use this ordinal as argument to the <code><a href="Xmla.Dataset.Cellset.html#method_getByOrdinal">getByOrdinal()</a></code> method of this Dataset's <code><a href="Xmla.Dataset.Cellset.html#class_Cellset">Cellset</a></code>.</p>

<p>Instead of calling this method and passing the result into the Cellsets <code><a href="Xmla.Dataset.Cellset.html#method_getByOrdinal">getByOrdinal()</a></code> method,
you can call the <code><a href="Xmla.Dataset.Cellset.html#method_getByTupleIndexes">getByTupleIndexes()</a></code> method  of this Dataset's <code><a href="Xmla.Dataset.Cellset.html#class_Cellset">Cellset</a></code>.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">A</code>
                        <span class="type">Int</span>
                    

                    

                    <div class="param-description">
                        <p>variable number of integer tuple indexes. Tuple indexes should be passed in descending order of axes.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    The ordinal number that identifies the cell from this Dataset's <code><a href="Xmla.Dataset.Cellset.html#class_Cellset">Xmla.Dataset.Cellset</a></code> that belongs to the tuples identified by the arguments.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_close" class="method item">
    <h3 class="name"><code>close</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5860"><code>src&#x2F;Xmla.js:5860</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Cleanup this Dataset object.</p>
    </div>

    

    

    
</div>

                
                    <div id="method_fetchAsObject" class="method item">
    <h3 class="name"><code>fetchAsObject</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5813"><code>src&#x2F;Xmla.js:5813</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Gets all of the XML data into one JS object. The object consists of the following members:</p>

<ul>
 <li><code>axes</code>: An array of objects that represent the query axes (but not the slicer axis).
 Each axis has a <code>positions</code> member which is an array of tuples, and a <code>hierarchies</code> member, which is an array of hierarchies.</li>
 <li><code>slicerAxis</code>: An object that represents the slicer axis, or null if there is no slicer axis.</li>
 <li><code>cells</code>: An array of cell objects, representing the cellset.</li>
</ul>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getAxis" class="method item">
    <h3 class="name"><code>getAxis</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>nameOrIndex</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5657"><code>src&#x2F;Xmla.js:5657</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the axis specified by the argument index or name.
If the axis does not exist, an <code>INVALID_AXIS</code> exception is thrown.
To prevent an exception from being thrown, you should call the <code><a href="#method_hasAxis">hasAxis()</a></code> method to determine if the axis exists.
Alternatively, you can call <code><a href="#method_axisCount">axisCount()</a></code>, and use an integer argument between zero (inclusive) and axis count (exclusive).</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">nameOrIndex</code>
                        <span class="type">String | int</span>
                    

                    

                    <div class="param-description">
                        <p>For int arguments, a value of 0 up to the number of axes. You can also use one of the <code>AXIS_xxx</code> constants. For string arguments, this method will match the name of the axis as it is returned in the XML/A response. These names are of the form <code>AxisN</code> where N is an ordinal that identifies the axis.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>:
                    
                    The <code><a href="Xmla.Dataset.Axis.html#class_Axis">Xmla.Dataset.Axis</a></code> object that corresponds to the argument.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getCellset" class="method item">
    <h3 class="name"><code>getCellset</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Cellset.html" class="crosslink">Xmla.Dataset.Cellset</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5788"><code>src&#x2F;Xmla.js:5788</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the Cellset object.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Cellset.html" class="crosslink">Xmla.Dataset.Cellset</a></span>:
                    
                    The <code><a href="Xmla.Dataset.Cellset.html#class_Cellset">Xmla.Dataset.Cellset</a></code> object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getChapterAxis" class="method item">
    <h3 class="name"><code>getChapterAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5755"><code>src&#x2F;Xmla.js:5755</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the Chapter axis. This is the fifth axis, and has ordinal 4. If the chapter axis doesn't exist, an <code>INVALID_AXIS</code> exception is thrown.
To prevent an exception from being thrown, you should call the <code><a href="#method_hasChapterAxis">hasChapterAxis()</a></code> method to determine if the axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>:
                    
                    The chapter <code><a href="Xmla.Dataset.Axis.html#class_Axis">Xmla.Dataset.Axis</a></code> object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getColumnAxis" class="method item">
    <h3 class="name"><code>getColumnAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5687"><code>src&#x2F;Xmla.js:5687</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the Column axis. This is the first axis, and has ordinal 0. If the column axis doesn't exist, an <code>INVALID_AXIS</code> exception is thrown.
To prevent an exception from being thrown, you should call the <code><a href="#method_hasColumnAxis">hasColumnAxis()</a></code> method to determine if the axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>:
                    
                    The column <code><a href="Xmla.Dataset.Axis.html#class_Axis">Xmla.Dataset.Axis</a></code> object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getPageAxis" class="method item">
    <h3 class="name"><code>getPageAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5721"><code>src&#x2F;Xmla.js:5721</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the Page axis. This is the third axis, and has ordinal 2. If the page axis doesn't exist, an <code>INVALID_AXIS</code> exception is thrown.
To prevent an exception from being thrown, you should call the <code><a href="#method_hasPageAxis">hasPageAxis()</a></code> method to determine if the axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>:
                    
                    The page <code><a href="Xmla.Dataset.Axis.html#class_Axis">Xmla.Dataset.Axis</a></code> object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getRowAxis" class="method item">
    <h3 class="name"><code>getRowAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5704"><code>src&#x2F;Xmla.js:5704</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the Row axis. This is the second axis, and has ordinal 1. If the row axis doesn't exist, an <code>INVALID_AXIS</code> exception is thrown.
To prevent an exception from being thrown, you should call the <code><a href="#method_hasRowAxis">hasRowAxis()</a></code> method to determine if the axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>:
                    
                    The row <code><a href="Xmla.Dataset.Axis.html#class_Axis">Xmla.Dataset.Axis</a></code> object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getSectionAxis" class="method item">
    <h3 class="name"><code>getSectionAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5738"><code>src&#x2F;Xmla.js:5738</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the Section axis. This is the fourth axis, and has ordinal 3. If the section axis doesn't exist, an <code>INVALID_AXIS</code> exception is thrown.
To prevent an exception from being thrown, you should call the <code><a href="#method_hasPageAxis">hasSectionAxis()</a></code> method to determine if the axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>:
                    
                    The section <code><a href="Xmla.Dataset.Axis.html#class_Axis">Xmla.Dataset.Axis</a></code> object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getSlicerAxis" class="method item">
    <h3 class="name"><code>getSlicerAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5772"><code>src&#x2F;Xmla.js:5772</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the Slicer axis. This is the axis that appears in the <code>WHERE</code> clause of the MDX statement.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/Xmla.Dataset.Axis.html" class="crosslink">Xmla.Dataset.Axis</a></span>:
                    
                    The slicer <code><a href="Xmla.Dataset.Axis.html#class_Axis">Xmla.Dataset.Axis</a></code> object.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasAxis" class="method item">
    <h3 class="name"><code>hasAxis</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>nameOrIndex</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5677"><code>src&#x2F;Xmla.js:5677</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determine if the axis specified by the argument exists.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">nameOrIndex</code>
                        <span class="type">String | int</span>
                    

                    

                    <div class="param-description">
                        <p>For int arguments, a value of 0 up to the number of axes. You can also use one of the <code>AXIS_xxx</code> constants. For string arguments, this method will match the name of the axis as it is returned in the XML/A response. These names are of the form <code>AxisN</code> where N is an ordinal that identifies the axis.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if the specified axis exists, <code>false</code> if it doesn't exist.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasChapterAxis" class="method item">
    <h3 class="name"><code>hasChapterAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5764"><code>src&#x2F;Xmla.js:5764</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determine if the chapter axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if the chapter axis exists, <code>false</code> if it doesn't exist.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasColumnAxis" class="method item">
    <h3 class="name"><code>hasColumnAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5696"><code>src&#x2F;Xmla.js:5696</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determine if the column axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if the column axis exists, <code>false</code> if it doesn't exist.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasPageAxis" class="method item">
    <h3 class="name"><code>hasPageAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5730"><code>src&#x2F;Xmla.js:5730</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determine if the page axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if the page axis exists, <code>false</code> if it doesn't exist.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasRowAxis" class="method item">
    <h3 class="name"><code>hasRowAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5713"><code>src&#x2F;Xmla.js:5713</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determine if the row axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if the row axis exists, <code>false</code> if it doesn't exist.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasSectionAxis" class="method item">
    <h3 class="name"><code>hasSectionAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5747"><code>src&#x2F;Xmla.js:5747</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determine if the section axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if the section axis exists, <code>false</code> if it doesn't exist.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasSlicerAxis" class="method item">
    <h3 class="name"><code>hasSlicerAxis</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5780"><code>src&#x2F;Xmla.js:5780</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Determine if the slicer axis exists.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if the slicer axis exists, <code>false</code> if it doesn't exist.
                
            </div>
        </div>
    

    
</div>

                
            </div>
        

        
            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

                
                    <div id="property_AXIS_CHAPTERS" class="property item">
    <h3 class="name"><code>AXIS_CHAPTERS</code></h3>
    <span class="type">Int</span>

    

    

    
        <span class="flag final">final</span>
    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5543"><code>src&#x2F;Xmla.js:5543</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Can be used as argument for <code><a href="#method_getAxis">getAxis()</a></code> to get the fifth axis (the chapters axis).
Alternatively you can simply call <code><a href="#method_getChapterAxis">getChapterAxis()</a></code></p>
    </div>

    
        <p><strong>Default:</strong> &lt;code&gt;4&lt;&#x2F;code&gt;</p>
    

    

    
</div>

                
                    <div id="property_AXIS_COLUMNS" class="property item">
    <h3 class="name"><code>AXIS_COLUMNS</code></h3>
    <span class="type">Int</span>

    

    

    
        <span class="flag final">final</span>
    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5503"><code>src&#x2F;Xmla.js:5503</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Can be used as argument for <code><a href="#method_getAxis">getAxis()</a></code> to get the first axis (the column axis).
Alternatively you can simply call <code><a href="#method_getColumnAxis">getColumnAxis()</a></code></p>
    </div>

    
        <p><strong>Default:</strong> &lt;code&gt;0&lt;&#x2F;code&gt;</p>
    

    

    
</div>

                
                    <div id="property_AXIS_PAGES" class="property item">
    <h3 class="name"><code>AXIS_PAGES</code></h3>
    <span class="type">Int</span>

    

    

    
        <span class="flag final">final</span>
    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5523"><code>src&#x2F;Xmla.js:5523</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Can be used as argument for <code><a href="#method_getAxis">getAxis()</a></code> to get the third axis (the page axis).
Alternatively you can simply call <code><a href="#method_getPageAxis">getPageAxis()</a></code></p>
    </div>

    
        <p><strong>Default:</strong> &lt;code&gt;2&lt;&#x2F;code&gt;</p>
    

    

    
</div>

                
                    <div id="property_AXIS_ROWS" class="property item">
    <h3 class="name"><code>AXIS_ROWS</code></h3>
    <span class="type">Int</span>

    

    

    
        <span class="flag final">final</span>
    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5513"><code>src&#x2F;Xmla.js:5513</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Can be used as argument for <code><a href="#method_getAxis">getAxis()</a></code> to get the second axis (the row axis).
Alternatively you can simply call <code><a href="#method_getRowAxis">getRowAxis()</a></code></p>
    </div>

    
        <p><strong>Default:</strong> &lt;code&gt;1&lt;&#x2F;code&gt;</p>
    

    

    
</div>

                
                    <div id="property_AXIS_SECTIONS" class="property item">
    <h3 class="name"><code>AXIS_SECTIONS</code></h3>
    <span class="type">Int</span>

    

    

    
        <span class="flag final">final</span>
    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5533"><code>src&#x2F;Xmla.js:5533</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Can be used as argument for <code><a href="#method_getAxis">getAxis()</a></code> to get the fourth axis (the section axis).
Alternatively you can simply call <code><a href="#method_getSectionAxis">getSectionAxis()</a></code></p>
    </div>

    
        <p><strong>Default:</strong> &lt;code&gt;3&lt;&#x2F;code&gt;</p>
    

    

    
</div>

                
                    <div id="property_AXIS_SLICER" class="property item">
    <h3 class="name"><code>AXIS_SLICER</code></h3>
    <span class="type">String</span>

    

    

    
        <span class="flag final">final</span>
    

    
        <span class="flag static">static</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l5553"><code>src&#x2F;Xmla.js:5553</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Can be used as argument for <code><a href="#method_getAxis">getAxis()</a></code> to get the slicer axis
(the axis that appears in the <code>WHERE</code> clause of an MDX-<code>SELECT</code> statement).
Alternatively you can simply call <code><a href="#method_getSlicerAxis">getSlicerAxis()</a></code></p>
    </div>

    
        <p><strong>Default:</strong> &lt;code&gt;SlicerAxis&lt;&#x2F;code&gt;</p>
    

    

    
</div>

                
            </div>
        

        

        
    </div>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
</body>
</html>
